home *** CD-ROM | disk | FTP | other *** search
/ The Programmer Disk / The Programmer Disk (Microforum).iso / xpro / extra / pro14 / readme.flw < prev   
Text File  |  1993-07-22  |  18KB  |  487 lines
  1. ==============================================================================
  2.  
  3.  
  4. TRANTOR LTD                         Home/Office   0639-633072
  5. GREEN HEDGES BUNGALOW               International 44-639-633072
  6. PONTARDAWE ROAD                     Mobile        0836-795445
  7. BRYNCOCH                            Fax       (manual switch, on request)
  8. NEATH  SA10 7YL
  9. WEST GLAMORGAN                      Directors:
  10. SOUTH WALES, UK                     N.H.Jennings, B.Sc., CEng, MBCS, FIAP
  11.                                     D.P.Jennings
  12.  
  13.  
  14. COMPUSERVE Id: 100040,471
  15.  
  16.  
  17. ==============================================================================
  18.                                    Contents
  19. ==============================================================================
  20.  
  21.  1.   Conditions of sale
  22.  2.   Registration
  23.  3.   About TRANTOR and our software
  24.  4.   General utilities
  25.  5.   COBOL utilities
  26.  6.   Items supplied on the disk
  27.  7.   Use and Performance
  28.  8.   History
  29.  9.   Documentation
  30.  A.   Aknowledgements
  31.  
  32. This software requires only a single drive, only 384k of memory, and uses
  33. only text-mode screens, so it should run on almost ANY IBM-compatible PC.
  34.  
  35. ==============================================================================
  36.                            1. Conditions of sale
  37. ==============================================================================
  38.  
  39. Copyright is retained by the author. The software on this disk is NOT public
  40. domain, and the purchaser is granted a limited licence to copy,
  41. distribute and use it for PERSONAL USE ONLY, subject to the following
  42. conditions:
  43.  
  44.    No changes are made to any file
  45.  
  46.    All files on the supplied disk are included on the copy
  47.  
  48.    No charge is made other than a reasonable fee for media, postage and copying
  49.  
  50.    If you make use of the software after an initial 30 day evaluation, you
  51.    MUST register. This is a legal requirement.
  52.  
  53.    Corporate users, and anyone using this software for commercial
  54.    purposes, MUST register and purchase the corresponding licence.
  55.  
  56.    The registered version must NOT be copied for distribution. It contains
  57.    a unique serial number which will identify the source of any copies.
  58.  
  59. ==============================================================================
  60.                                2. Registration
  61. ==============================================================================
  62.  
  63.  
  64. Please send £4 for the shareware version, or £12 for the registered version
  65. of any of our PC programs, to the address given at the start of this file.
  66. This includes VAT, currently at 17.5%
  67.  
  68. Registration helps to pay for further development, which is ultimately for
  69. YOUR benefit. We are a SMALL company, and the little income from
  70. registration goes to support myself, my wife and 4 children, (and the Tax
  71. man), NOT into luxury office buildings or executive cars! I still have to
  72. work as a freelance in order to live.
  73.  
  74. For non-UK users, please send $25 or equivalent. This is because the bank
  75. charges a minimum of $4 for currency conversion (cash) or $9 for cashing a
  76. foreign cheque (check). Also, overseas mailing costs more. (The volume of
  77. registrations does not yet allow us to offer credit card facilities.)
  78.  
  79. Note: A VAT receipt can be supplied on request.
  80.  
  81. ==============================================================================
  82.                       3. About TRANTOR and our software
  83. ==============================================================================
  84.  
  85. Trantor Ltd is a small consultancy, originally  specialising in software
  86. for ICL mainframes. Our programs are installed on ICL Mainframes in the
  87. UK, and as far away as Australia. We have recently ported many of our
  88. mainframe COBOL utilities onto IBM PC's.
  89.  
  90. Our current range includes the following items which run under ICL's VME
  91. operating system. Please contact us for further details.
  92.  
  93.     COBFORM  : COBOL reformatter and         PC and IBM/MVS versions available
  94.                Structured programming preprocessor
  95.     MFE      : MULTI_FILE_EDIT               PC demo available on request
  96.     FAM      : File_Amender                  PC demo available on request
  97.     TRANSIT  : Transfers OMF's between machines via
  98.                MS-DOS floppy and/or FTF
  99.     MANTXREF : MANTIS cross reference        PC demo available
  100.                and other utilities
  101.     COBSTR   : COBOL source documentation aid/structure charter
  102.                                              PC & IBM/MVS versions available
  103.  
  104.  
  105. Our PC software includes the following shareware products
  106.  
  107. COBOL utilities
  108.  
  109.     These are compatible with many compilers, including R. Noweck's
  110.     shareware COBOL600 and COBOL650. They can also handle COBOL source
  111.     downloaded from a number of different hardware platforms.
  112.  
  113.     COBFORM  : as above
  114.     COBSTR   : COBOL source analyzer, documentation aid & structure charter
  115.     COBFLOW  : COBOL source logic charter
  116.     COBTABLE : COBOL record and structure layout print
  117.     COBXREF  : COBOL Cross reference list
  118.     PSICO    : Structured COBOL development aid
  119.  
  120. The following PC program is available on a commercial basis only, ie it is NOT
  121. available as shareware. A demo IS available, and the package could be made
  122. available on other hardware, as it is itself written in COBOL.
  123.  
  124.     COBWEB   : COBOL structure analyzer, assists reverse engineering
  125.                and re-engineering of old COBOL.
  126.  
  127. Other shareware
  128.  
  129.     MATCH    : Interactive file compare
  130.     SECURE   : Security aid
  131.     NJTREE   : Yet another directory tree program
  132.     DELTREE  : Directory tree deletion
  133.  
  134. ==============================================================================
  135.                      4. General Software and Utilities
  136. ==============================================================================
  137.  
  138. MULTI_FILE_EDIT
  139. ===============
  140.  
  141. This is a full-screen text editor for ICL 2900 and Series 39 mainframe
  142. computers
  143.  
  144. It features
  145.       Simultaneous editing of a number of files,
  146.       Cut and paste between files
  147.       Split screen working
  148.       Editing of long records (up to 2040 bytes)
  149.       Hexadecimal screen edit
  150.       Built-in COBOL and SCL reformatters
  151.       Insertion of Path Analysis and Trace code into COBOL source
  152.       COBOL Animator, for single step execution with source display
  153.       Text compression
  154.       Built-in structured COBOL preprocessor
  155.  
  156.       and many other useful functions.
  157.  
  158. A PC-based demonstration version, with tutorial file, is available from us
  159. on request, for a nominal charge. (It requires at least 512k of memory.)
  160.  
  161.  
  162. FAM - File Amender
  163. ==================
  164.  
  165. For ICL 2900 and Series 39 mainframe computers.
  166.  
  167. This is an interactive utility for amending a serial or indexed file.
  168.  
  169. It features
  170.  
  171.     Full screen record display, including datanames as well as the data
  172.     Conversion of data to and from COMPUTATIONAL, COMP-3 and hexadecimal
  173.     Automatic record initialisation
  174.     Insertion, amendment and deletion of records
  175.     Optional display of COBOL Group names and redefinitions
  176.     Print of selected records
  177.     Optional Autoprint of changed records
  178.  
  179. A PC demonstration version is available on request.
  180.  
  181. MATCH : File comparison
  182. =======================
  183.  
  184. This IBM/PC interactive file comparison will enable two text files to be
  185. compared, with the differences between individual pairs of records indicated.
  186.  
  187. When a mismatch occurs, the next 8 records of each file are displayed. You
  188. will be able to step one or both files forwards until matching is
  189. re-established, and the program then proceeds to the next mismatching pair.
  190.  
  191. It can display in Hex as well as ASCII, can handle binary data, and allows
  192. left and right margins to limit the range of columns compared.
  193.  
  194. It is accompanied by other MS-DOS utilities:
  195.  
  196.    NJTREE    Directory Tree display
  197.    DELTREE   Directory Tree deletion
  198.    SECURE    Directory Tree renaming
  199.  
  200. ==============================================================================
  201.                             5. COBOL Utilities
  202. ==============================================================================
  203.  
  204. COBOL Reformatter - COBFORM
  205. ===========================
  206.  
  207. This program allows you to reformat COBOL programs to conform to your own
  208. preferred layout. It also contains a structured programming preprocessor which
  209. converts structured programming commands into valid COBOL.
  210.  
  211. The layout of the converted program is defined in a table which specifies the
  212. alignment of selected COBOL verbs, reserved words and datanames. Two sample
  213. tables are supplied, one of which contains the structure verbs.
  214.  
  215. The table also allows you to perform global replacements of selected keywords
  216. througout the text, thus you can change all occurrences of a dataname or a
  217. paragraph name.
  218.  
  219. You can also specify input and output "card" layouts, and can therefore
  220. convert to and from various nonstandard source formats, such as DEC and UTAH.
  221. The other utilities below require a standard source layout, and therefore
  222. COBFORM may be needed in order to convert the source first.
  223.  
  224. In the PC and ICL versions, COBOL MACROs are available. A library of well
  225. designed and tested macros can make a substantial contribution to
  226. productivity, as well as reducing the scope for program errors.
  227.  
  228. COBXREF - COBOL cross reference
  229. ===============================
  230.  
  231. This provides a sorted cross reference of COBOL programs. It includes all
  232. datanames, paragraph and section names.Some COBOL reserved words may
  233. be included, as well as numeric literals and some PICTURE clauses. Most
  234. COBOL verbs are filtered out.
  235.  
  236. All dialects of COBOL are allowed, provided that the standard COBOL card
  237. layout is used, ie columns 1-6 for sequence, 7 for comment, 8-72 for source
  238. text. The program can cope with large programs, up to about 7000 source lines,
  239. depending on the complexity and number of datanames.
  240.  
  241. COBFLOW - COBOL LOGIC CHARTER
  242. ==============================
  243.  
  244. COBSRC produces a file which contains details of all sections, paragraphs, GO
  245. TO's, PERFORMS and STOP's (including EXIT PROGRAM and GOBACK) within a COBOL
  246. source.
  247.  
  248. It is compatible with all versions of COBOL prior to ANS85. (It is not
  249. expected that programs written to ANS85 standard will need this facility)
  250.  
  251. COBFLOW takes this analysis file, and produces a logic chart. Although not yet
  252. a full flowchart, it is nevertheless a useful tool in investigating old
  253. programs.
  254.  
  255. Further development is dependent on YOUR support, by registration.
  256.  
  257. COBWEB - COBOL program analyzer
  258. ===============================
  259.  
  260. This program represents a break-through in COBOL re-engineering, and is a step
  261. on the road to automated restructuring of old code, pre ANS85. (It is not
  262. expected that programs written to ANS85 standard will need this facility)
  263.  
  264. It is developed from COBFLOW and is able to indicate subsets of a COBOL source
  265. which are self-contained and can be taken out of line to be performed.
  266.  
  267. A further program is under development which will perform the actual code
  268. amendments indicated by COBWEB.
  269.  
  270. It is not intended to issue this program as Shareware, although a cut-down
  271. demonstration version is available, which is fully functional except for a
  272. limit on the number of paragraph names within a SECTION.
  273.  
  274. PSICO
  275. =====
  276.  
  277. This is a program for interactive development of structured COBOL programs.
  278.  
  279. It contains formatted screens to capture the body of each program
  280. structure, reducing the development time and ensuring correct structure
  281. syntax is used.
  282.  
  283. The output is a structured program in a suitable form for input to
  284. COBFORM, which will then convert it to standard (ANS74) COBOL.
  285.  
  286.  
  287. ==============================================================================
  288.                              6. Items supplied
  289. ==============================================================================
  290.  
  291. COBFLOW.EXE    COBFLOW program, version 1.00
  292. COBWEBS.EXE    Demo version of COBWEB
  293. COBSRC.EXE     COBSRC program, version 1.00
  294.  
  295. README.FLW     This file
  296.  
  297. FLOWTEST.CBL   Example of COBOL source as input to COBSRC, to generate:
  298. FLOWTEST.TXT   the sample test file for input to COBFLOW
  299.  
  300. EXAMPLE.TXT    Example used by COBWEBS
  301. EXAMPLE.CBL    COBOL source of COBWEBS example
  302.  
  303. COBTABLE TXT   Table file used by COBSRC
  304.  
  305.  
  306. ==============================================================================
  307.                             7. Use and Performance
  308. ==============================================================================
  309.  
  310. Note that the programs should be in the current directory.
  311.  
  312. COBSRC should first be run on the source file to produce a work
  313. file with a TXT extension. (or use the EXAMPLE.TXT supplied)
  314.  
  315. COBFLOW will read the .TXT file and produce a .PRN file containing the
  316. chart
  317.  
  318. COBWEBS will read EXAMPLE.TXT and create or replace EXAMPLE.PRN
  319.  
  320. Note: If you have PKLITE, you can use it to compress the programs.
  321.  
  322. 5.1 ERRORS
  323. ==========
  324.  
  325. File errors (with file status) will be reported if any file fails to open.
  326.  
  327. 5.2 HARDWARE REQUIREMENTS
  328. =========================
  329.  
  330. Any IBM-compatible PC, with 384k, one drive, and any monitor.
  331.  
  332.  
  333. ==============================================================================
  334.                                 8. History
  335. ==============================================================================
  336.  
  337. Version 1.00  July   1993 - Initial PC version
  338. Version 1.01  July   1993 - COBSTR replaced by COBSRC, which is smaller,
  339.                             faster, and has fewer bugs (I hope!)
  340.  
  341. ==============================================================================
  342.                                9. Documentation
  343. ==============================================================================
  344.  
  345. This file contains all necessary documentation.
  346.  
  347. 9.1 COBSRC
  348. ===========
  349.  
  350.    COBSRC analyses the structure of a COBOL program, creating an
  351.    intermediate file of paragraph, PERFORM and GOTO information.
  352.  
  353.       Command line parameters are :
  354.          IN=    input COBOL source file
  355.          OUT=   name for intermediate file. Default is inputname.TXT
  356.          TAB=   table file name. Do not override the default
  357.  
  358.        The keywords are not needed if parameters are given in the stated order
  359.  
  360.        If no extension is present on the input file name, .CBL is
  361.        assumed.
  362.  
  363.  
  364.     c:>COBSRC  IN=SAMPLE.CBL  OUT=SAMPLE.TXT
  365.  
  366.     OUTPUT FILE CLOSED
  367.     END OF INPUT REACHED
  368.     END OF RUN
  369.  
  370.  
  371. Note that for correct operation of COBFLOW, the COBOL source MUST have
  372. either a SECTION or a PARAGRAPH at the start of the PROCEDURE DIVISION,
  373. before any executable code.
  374.  
  375.  
  376. 9.2 COBFLOW
  377. ===========
  378.  
  379. Parameters
  380. ==========
  381.  
  382. COBFLOW uses the following
  383.  
  384.     IN=        Name of .TXT file previously created by COBSRC
  385.     OUT=       Name for output .PRN file
  386.     PERFORM=Y to show all performs, otherwise they are not shown,
  387.                giving a smaller print
  388.  
  389. COBWEBS has no parameters
  390.  
  391.  
  392. Restrictions
  393. ============
  394.  
  395.     Source file size    :  No restriction, provided the procedure
  396.                            division is broken into SECTION's
  397.  
  398.     COBOL Section       :  Maximum of 2000 references including
  399.                            Paragraph names, GO TO's and PERFORMs.
  400.                            If exceeded, try PERFORM=N
  401.  
  402.                            COBWEBS - maximum 30 references
  403.  
  404.     GO TO's and PERFORMs from one section to another are shown ONLY
  405.     at the ORIGIN, not in the target section. This should not be a
  406.     major problem.
  407.  
  408.     At a later version, a summary of these inter-section references could
  409.     be printed.
  410.  
  411.     PERFORM THRU's are NOT indicated separately in this version.
  412.  
  413.  
  414. Performance
  415. ===========
  416.  
  417.     The program reads and processes one SECTION at a time, which helps
  418.     to keep processing time and memory requirements to a minimum.
  419.  
  420.     Since the program does a lot of sequential table searching, the
  421.     time to process a section is of the order of N squared, where N is
  422.     the number of references within the section.
  423.  
  424.     Thus a section with 200 references will typically take 4 times as
  425.     long as a section with 100 references.
  426.  
  427.     A new page is started for each SECTION.
  428.  
  429. Processing
  430. ==========
  431.  
  432.     COBFLOW processes each section as follows:
  433.  
  434.        Read all references into a table
  435.        Resolve all references in table
  436.        Print each reference as follows:
  437.            Print INWARD references to this paragraph
  438.              (ie GO TO's ands PERFORMS from other paragraphs)
  439.            Print OUTWARD references
  440.              (ie GO TO's ands PERFORMS to other paragraphs)
  441.  
  442.            ( Forward and backward references are distinguished by elbow
  443.             characters, which may not be printed correctly, depending on
  444.             the printer character set.)
  445.  
  446.        Printing of PERFORMs can be suppressed by parameter.
  447.  
  448.        The program will retain paragraph sequence from the source,
  449.        and indicate any unconditional transfer of control by
  450.  
  451.         ==== NO FALL THRU ====
  452.  
  453.        which indicates that the following paragraph can only be entered
  454.        by a PERFORM or GO TO.
  455.  
  456. Examples
  457. ========
  458.  
  459.        A sample COBOL program, and the chart produced, are provided
  460.        with the software.
  461.  
  462.        A sample TXT file is also provided, which can be used for test
  463.        runs by typing the following at the DOS prompt:
  464.  
  465.            COBFLOW IN=FLOWTEST.TXT OUT=FLOWTEST.PRN
  466.  
  467.        or just
  468.  
  469.            COBFLOW FLOWTEST
  470.  
  471.         To run the COBWEBS demo, just type COBWEBS
  472.  
  473.  
  474. ==============================================================================
  475.                             A. Aknowledgements
  476. ==============================================================================
  477.  
  478.  
  479.   MANTIS is a registered trade mark of CINCOM Systems
  480.   IBM    International Business Machines
  481.   MVS    IBM operating system
  482.   ICL    International Computers Ltd
  483.   VME    ICL operating system for 2900 & Series 39
  484.  
  485.  
  486.  
  487.